Platform Explorer / Nuxeo Platform 2021.26

Operation Document.SetBlobName (Set File Name)

Description

Modify the filename of a file stored in the input document. The file is found in the input document given its xpath specified through the 'xpath' parameter. Return back the input document.
Operation id Document.SetBlobName
AliasesBlob.SetFilename
Category Files
Label Set File Name
Requires
Since

Parameters

Name Description Type Required Default value
name string yes  
save boolean no true 
xpath string no file:content 

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.blob.SetBlobFileName
Contributing Component org.nuxeo.ecm.core.automation.coreContrib

JSON Definition

{
  "id" : "Document.SetBlobName",
  "aliases" : [ "Blob.SetFilename" ],
  "label" : "Set File Name",
  "category" : "Files",
  "requires" : null,
  "description" : "Modify the filename of a file stored in the input document. The file is found in the input document given its xpath specified through the 'xpath' parameter. Return back the input document.",
  "url" : "Document.SetBlobName",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "name",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "save",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  }, {
    "name" : "xpath",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "file:content" ]
  } ]
}